onDelay hook
#47
onDelay hook
#47
Conversation
test.js
Outdated
| t.is(delayedCounter, delayedExecutions); | ||
|
|
||
| await Promise.all(promises); | ||
| t.pass(); |
There was a problem hiding this comment.
| t.pass(); |
This is moot.
index.d.ts
Outdated
| /** | ||
| A callback for when a call gets delayed due to the number of calls in the `interval` exceeded the `limit`. |
There was a problem hiding this comment.
| /** | |
| A callback for when a call gets delayed due to the number of calls in the `interval` exceeded the `limit`. | |
| /** | |
| Get notified when function calls are delayed due to exceeding the `limit` of allowed calls within a the given `interval`. |
index.d.ts
Outdated
| await throttled(); //=> Reached the interval limit, the call is delayed | ||
| ``` | ||
| */ | ||
| readonly onDelay?: () => void | Promise<void>; |
There was a problem hiding this comment.
| readonly onDelay?: () => void | Promise<void>; | |
| readonly onDelay?: () => void; |
It should not have Promise here when it does not actually await the returned promise.
There was a problem hiding this comment.
Makes sense, removed
|
Should be documented in the readme too. |
Added to the readme |
readme.md
Outdated
| const throttle = pThrottle({ | ||
| limit: 2, | ||
| interval: 1000, | ||
| onDelay: () => console.log('Reached the interval limit, the call is delayed'), |
There was a problem hiding this comment.
This is not the same as the one in index.d.ts (missing braces). Make sure they are both in sync.
There was a problem hiding this comment.
You synced it the wrong way.
The changes in ba5ef67 should be preserved.
|
Is it possible to get details of the request being made when the onDelay callback is triggered? |
|
We can add the arguments of the delayed call. Would that help? |
Hey @dormeiri - yes I think that should be good. Thanks |
Fixes #44